com.inscoper.nbo.LightGuide

Represents the XML element LightGuide. More...

Inherits from com.inscoper.nbo.LightSourceCoupling_Type, com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	LightGuide()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setType(LightGuideType_Type value) Sets the value of the Type attribute.
LightGuideType_Type	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
void	setRefractiveIndex(float value) Sets the value of the RefractiveIndex attribute.
float	getRefractiveIndex() Returns the value of the RefractiveIndex attribute.
void	resetRefractiveIndex() Resets the RefractiveIndex attribute to an unset state.
boolean	hasRefractiveIndex() Checks whether the optional RefractiveIndex attribute is present.
void	setNumericalAperture(float value) Sets the value of the NumericalAperture attribute.
float	getNumericalAperture() Returns the value of the NumericalAperture attribute.
void	setAcceptanceAngle(float value) Sets the value of the AcceptanceAngle attribute.
float	getAcceptanceAngle() Returns the value of the AcceptanceAngle attribute.
void	resetAcceptanceAngle() Resets the AcceptanceAngle attribute to an unset state.
boolean	hasAcceptanceAngle() Checks whether the optional AcceptanceAngle attribute is present.
void	setAcceptanceAngleUnit(UnitsAngle_Type value) Sets the value of the AcceptanceAngleUnit attribute.
UnitsAngle_Type	getAcceptanceAngleUnit() Returns the value of the AcceptanceAngleUnit attribute.
void	resetAcceptanceAngleUnit() Resets the AcceptanceAngleUnit attribute to an unset state.
boolean	hasAcceptanceAngleUnit() Checks whether the optional AcceptanceAngleUnit attribute is present.
void	setGeometry(LightGuideGeometry_Type value) Sets the value of the Geometry attribute.
LightGuideGeometry_Type	getGeometry() Returns the value of the Geometry attribute.
void	resetGeometry() Resets the Geometry attribute to an unset state.
boolean	hasGeometry() Checks whether the optional Geometry attribute is present.
void	setMaterialName(LightGuideMaterialName_Type value) Sets the value of the MaterialName attribute.
LightGuideMaterialName_Type	getMaterialName() Returns the value of the MaterialName attribute.
void	resetMaterialName() Resets the MaterialName attribute to an unset state.
boolean	hasMaterialName() Checks whether the optional MaterialName attribute is present.
void	setSingleMode(boolean value) Sets the value of the SingleMode attribute.
boolean	getSingleMode() Returns the value of the SingleMode attribute.
void	resetSingleMode() Resets the SingleMode attribute to an unset state.
boolean	hasSingleMode() Checks whether the optional SingleMode attribute is present.
void	setWaveguideMode(LightGuideWaveguideMode_Type value) Sets the value of the WaveguideMode attribute.
LightGuideWaveguideMode_Type	getWaveguideMode() Returns the value of the WaveguideMode attribute.
void	resetWaveguideMode() Resets the WaveguideMode attribute to an unset state.
boolean	hasWaveguideMode() Checks whether the optional WaveguideMode attribute is present.
void	setDiameter(float value) Sets the value of the Diameter attribute.
float	getDiameter() Returns the value of the Diameter attribute.
void	resetDiameter() Resets the Diameter attribute to an unset state.
boolean	hasDiameter() Checks whether the optional Diameter attribute is present.
void	setDiameterUnit(UnitsLength_Type value) Sets the value of the DiameterUnit attribute.
UnitsLength_Type	getDiameterUnit() Returns the value of the DiameterUnit attribute.
void	resetDiameterUnit() Resets the DiameterUnit attribute to an unset state.
boolean	hasDiameterUnit() Checks whether the optional DiameterUnit attribute is present.
void	setWavelengthRange_List(WavelengthRangeVector value) Sets the list of WavelengthRange elements.
WavelengthRangeVector	getWavelengthRange_List() Returns the list of WavelengthRange elements.
void	addToWavelengthRange_List(WavelengthRange value) Adds a new WavelengthRange element to this object.
void	clearWavelengthRange_List() Clear the list of WavelengthRange.
LightGuide	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	LightGuide(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(LightGuide obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.LightSourceCoupling_Type

	Name
	LightSourceCoupling_Type()
void	setID(LightSourceCouplingID_Type value) Sets the value of the ID attribute.
LightSourceCouplingID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setAttenuation(float value) Sets the value of the Attenuation attribute.
float	getAttenuation() Returns the value of the Attenuation attribute.
void	setTransmittance(float value) Sets the value of the Transmittance attribute.
float	getTransmittance() Returns the value of the Transmittance attribute.
void	resetTransmittance() Resets the Transmittance attribute to an unset state.
boolean	hasTransmittance() Checks whether the optional Transmittance attribute is present.
void	setCouplingLensRef(LensRef_Type value) Sets the value of the CouplingLensRef element.
LensRef_Type	getCouplingLensRef() Returns the value of the CouplingLensRef element.
void	resetCouplingLensRef() Resets the CouplingLensRef element to an unset state.
boolean	hasCouplingLensRef() Checks whether the optional CouplingLensRef element is present.
void	setAnnotationRef(LightSourceCoupling_Type_InlineAnnotationRef value) Sets the value of the AnnotationRef element.
LightSourceCoupling_Type_InlineAnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.

Protected Functions inherited from com.inscoper.nbo.LightSourceCoupling_Type

	Name
	LightSourceCoupling_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the optional LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.LightGuide;

Represents the XML element LightGuide.

A Light Guide coupling between the Light Source and the Microscope Stand generally consists of a casing enclosing a medium (i.e., typically fiber optic) capable of transferring light from the illuminator to the back of the Microscope Stand.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.delete

function LightGuide

public LightGuide()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.toXmlFile

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.toXmlString

function setType

public void setType(
    LightGuideType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

This field records the general category of Light Guide used in this case.

function getType

public LightGuideType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

This field records the general category of Light Guide used in this case.

function resetType

public void resetType()

Resets the Type attribute to an unset state.

This field records the general category of Light Guide used in this case.

function hasType

public boolean hasType()

Checks whether the optional Type attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the general category of Light Guide used in this case.

function setRefractiveIndex

public void setRefractiveIndex(
    float value
)

Sets the value of the RefractiveIndex attribute.

Parameters:

value The value to set

This field records the Refractive Index of the material used to construct this Light Guide.

function getRefractiveIndex

public float getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

Return: The value of the attribute

This field records the Refractive Index of the material used to construct this Light Guide.

function resetRefractiveIndex

public void resetRefractiveIndex()

Resets the RefractiveIndex attribute to an unset state.

This field records the Refractive Index of the material used to construct this Light Guide.

function hasRefractiveIndex

public boolean hasRefractiveIndex()

Checks whether the optional RefractiveIndex attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the Refractive Index of the material used to construct this Light Guide.

function setNumericalAperture

public void setNumericalAperture(
    float value
)

Sets the value of the NumericalAperture attribute.

Parameters:

value The value to set

The Numerical Aperture (NA) of this device expressed as a floating-point (real) number. NA can be calculated from the Angular Aperture (alpha) using the following formula, NA

function getNumericalAperture

public float getNumericalAperture()

Returns the value of the NumericalAperture attribute.

Return: The value of the attribute

The Numerical Aperture (NA) of this device expressed as a floating-point (real) number. NA can be calculated from the Angular Aperture (alpha) using the following formula, NA

function setAcceptanceAngle

public void setAcceptanceAngle(
    float value
)

Sets the value of the AcceptanceAngle attribute.

Parameters:

value The value to set

The angle within which the light beam produced by a Light Source may be coupled with the bound modes of this Light Guide.

function getAcceptanceAngle

public float getAcceptanceAngle()

Returns the value of the AcceptanceAngle attribute.

Return: The value of the attribute

The angle within which the light beam produced by a Light Source may be coupled with the bound modes of this Light Guide.

function resetAcceptanceAngle

public void resetAcceptanceAngle()

Resets the AcceptanceAngle attribute to an unset state.

The angle within which the light beam produced by a Light Source may be coupled with the bound modes of this Light Guide.

function hasAcceptanceAngle

public boolean hasAcceptanceAngle()

Checks whether the optional AcceptanceAngle attribute is present.

Return: true if the optional attribute has been set, false otherwise

The angle within which the light beam produced by a Light Source may be coupled with the bound modes of this Light Guide.

function setAcceptanceAngleUnit

public void setAcceptanceAngleUnit(
    UnitsAngle_Type value
)

Sets the value of the AcceptanceAngleUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getAcceptanceAngleUnit

public UnitsAngle_Type getAcceptanceAngleUnit()

Returns the value of the AcceptanceAngleUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetAcceptanceAngleUnit

public void resetAcceptanceAngleUnit()

Resets the AcceptanceAngleUnit attribute to an unset state.

No description available in the XSD standard.

function hasAcceptanceAngleUnit

public boolean hasAcceptanceAngleUnit()

Checks whether the optional AcceptanceAngleUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setGeometry

public void setGeometry(
    LightGuideGeometry_Type value
)

Sets the value of the Geometry attribute.

Parameters:

value The value to set

This field records the cross-section shape of this Light Guide.

function getGeometry

public LightGuideGeometry_Type getGeometry()

Returns the value of the Geometry attribute.

Return: The value of the attribute

This field records the cross-section shape of this Light Guide.

function resetGeometry

public void resetGeometry()

Resets the Geometry attribute to an unset state.

This field records the cross-section shape of this Light Guide.

function hasGeometry

public boolean hasGeometry()

Checks whether the optional Geometry attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the cross-section shape of this Light Guide.

function setMaterialName

public void setMaterialName(
    LightGuideMaterialName_Type value
)

Sets the value of the MaterialName attribute.

Parameters:

value The value to set

This field records the chemical composition or the non-proprietary trade designation of the material used to construct this Light Guide.

function getMaterialName

public LightGuideMaterialName_Type getMaterialName()

Returns the value of the MaterialName attribute.

Return: The value of the attribute

This field records the chemical composition or the non-proprietary trade designation of the material used to construct this Light Guide.

function resetMaterialName

public void resetMaterialName()

Resets the MaterialName attribute to an unset state.

This field records the chemical composition or the non-proprietary trade designation of the material used to construct this Light Guide.

function hasMaterialName

public boolean hasMaterialName()

Checks whether the optional MaterialName attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the chemical composition or the non-proprietary trade designation of the material used to construct this Light Guide.

function setSingleMode

public void setSingleMode(
    boolean value
)

Sets the value of the SingleMode attribute.

Parameters:

value The value to set

This field records whether (True) this Light Guide is single-mode. If not (False), then the guide is assumend to be multi-modal.

function getSingleMode

public boolean getSingleMode()

Returns the value of the SingleMode attribute.

Return: The value of the attribute

This field records whether (True) this Light Guide is single-mode. If not (False), then the guide is assumend to be multi-modal.

function resetSingleMode

public void resetSingleMode()

Resets the SingleMode attribute to an unset state.

This field records whether (True) this Light Guide is single-mode. If not (False), then the guide is assumend to be multi-modal.

function hasSingleMode

public boolean hasSingleMode()

Checks whether the optional SingleMode attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records whether (True) this Light Guide is single-mode. If not (False), then the guide is assumend to be multi-modal.

function setWaveguideMode

public void setWaveguideMode(
    LightGuideWaveguideMode_Type value
)

Sets the value of the WaveguideMode attribute.

Parameters:

value The value to set

This field records the transverse mode (or superposition of such modes) that are being imposed by this light guide onto the light wave traversing it. These modes generally follow different propagation constants.

function getWaveguideMode

public LightGuideWaveguideMode_Type getWaveguideMode()

Returns the value of the WaveguideMode attribute.

Return: The value of the attribute

This field records the transverse mode (or superposition of such modes) that are being imposed by this light guide onto the light wave traversing it. These modes generally follow different propagation constants.

function resetWaveguideMode

public void resetWaveguideMode()

Resets the WaveguideMode attribute to an unset state.

This field records the transverse mode (or superposition of such modes) that are being imposed by this light guide onto the light wave traversing it. These modes generally follow different propagation constants.

function hasWaveguideMode

public boolean hasWaveguideMode()

Checks whether the optional WaveguideMode attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the transverse mode (or superposition of such modes) that are being imposed by this light guide onto the light wave traversing it. These modes generally follow different propagation constants.

function setDiameter

public void setDiameter(
    float value
)

Sets the value of the Diameter attribute.

Parameters:

value The value to set

This fields records the outer diameter of this Light Guide.

function getDiameter

public float getDiameter()

Returns the value of the Diameter attribute.

Return: The value of the attribute

This fields records the outer diameter of this Light Guide.

function resetDiameter

public void resetDiameter()

Resets the Diameter attribute to an unset state.

This fields records the outer diameter of this Light Guide.

function hasDiameter

public boolean hasDiameter()

Checks whether the optional Diameter attribute is present.

Return: true if the optional attribute has been set, false otherwise

This fields records the outer diameter of this Light Guide.

function setDiameterUnit

public void setDiameterUnit(
    UnitsLength_Type value
)

Sets the value of the DiameterUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getDiameterUnit

public UnitsLength_Type getDiameterUnit()

Returns the value of the DiameterUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetDiameterUnit

public void resetDiameterUnit()

Resets the DiameterUnit attribute to an unset state.

No description available in the XSD standard.

function hasDiameterUnit

public boolean hasDiameterUnit()

Checks whether the optional DiameterUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setWavelengthRange_List

public void setWavelengthRange_List(
    WavelengthRangeVector value
)

Sets the list of WavelengthRange elements.

Parameters:

value The new list of WavelengthRange elements

This element records a range of Wavelengths this component is designed for, according to the Manufacturer. Multiple of this element may be used.

function getWavelengthRange_List

public WavelengthRangeVector getWavelengthRange_List()

Returns the list of WavelengthRange elements.

Return: The list of WavelengthRange elements

This element records a range of Wavelengths this component is designed for, according to the Manufacturer. Multiple of this element may be used.

function addToWavelengthRange_List

public void addToWavelengthRange_List(
    WavelengthRange value
)

Adds a new WavelengthRange element to this object.

Parameters:

value The element to add

This element records a range of Wavelengths this component is designed for, according to the Manufacturer. Multiple of this element may be used.

function clearWavelengthRange_List

public void clearWavelengthRange_List()

Clear the list of WavelengthRange.

This element records a range of Wavelengths this component is designed for, according to the Manufacturer. Multiple of this element may be used.

function __internal_create

public static LightGuide __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.__internal_create

Protected Functions Documentation

function LightGuide

protected LightGuide(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.finalize

function getCPtr

protected static long getCPtr(
    LightGuide obj
)

Updated on 2026-02-13 at 16:11:03 +0100